[ALL-GENS;DEV-EX / EASE-OF-USE] - add javadocs to all codegens pointing to the dirs containing their relevant templates#23606
Open
Picazsoo wants to merge 3 commits intoOpenAPITools:masterfrom
Conversation
Contributor
There was a problem hiding this comment.
3 issues found across 161 files
Note: This PR contains a large number of files. cubic only reviews up to 75 files per PR, so some files may not have been reviewed. cubic prioritises the most important files to review.
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaHelidonClientCodegen.java">
<violation number="1" location="modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaHelidonClientCodegen.java:46">
P3: Class Javadoc points only to the common template directory, but this generator also uses the client template directory, making the navigation guidance incomplete/misleading.</violation>
</file>
<file name="modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/GdscriptClientCodegen.java">
<violation number="1" location="modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/GdscriptClientCodegen.java:22">
P3: Javadoc says Mustache templates, but this generator uses Handlebars templates.</violation>
</file>
<file name="modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaResteasyServerCodegen.java">
<violation number="1" location="modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaResteasyServerCodegen.java:35">
P2: Class Javadoc is placed after `@Setter`, so tooling may not attach it to the class declaration.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When developing in OAP (introducing new functionality/fixing bugs), it is tiresome to search for the relevant directories containing the templates for each generator. This PR introduces javadocs to all the codegens making the ńavigation to the templates directories much easier.
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)Summary by cubic
Added class-level Javadocs to all generators pointing to their template directories to make template discovery fast and consistent. For multi-library generators, docs list root vs
libraries/paths and note that library templates shadow root templates.*Codegenclass with itssrc/main/resources/...template path(s).gdscript), and moved annotations below Javadocs so the docs attach to the class.Written for commit 489dff0. Summary will update on new commits.